package com.michale.system.mapper.permissions;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.michale.common.domain.permissions.UserEntity;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.List;

/**
 * @Auther Michale
 * @apiNote 用户信息表 mapper类
 */
@Mapper
public interface UserMapper extends BaseMapper<UserEntity> {

    /**
     * 根据条件分页查询用户列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectUserList(UserEntity userEntity);

    /**
     * 根据用户名查询用户详细信息
     *
     * @param userName 用户名
     * @return 用户详细信息
     */
    UserEntity selectUserByUserName(@Param("userName") String userName);

    /**
     * 新增用户信息
     *
     * @param userEntity 用户信息
     * @return 结果
     */
    int insertUser(UserEntity userEntity);

    /**
     * 修改用户信息
     *
     * @param userEntity 用户信息
     * @return 结果
     */
    int updateUser(UserEntity userEntity);

    /**
     * 修改用户头像
     *
     * @param userName 用户名
     * @param avatar   头像地址
     * @return 结果
     */
    int updateUserAvatar(@Param("userName") String userName, @Param("avatar") String avatar);

    /**
     * 重置用户密码
     *
     * @param userName 用户名
     * @param password 密码
     * @return 结果
     */
    int resetUserPwd(@Param("userName") String userName, @Param("password") String password);

    /**
     * 通过用户ID删除用户
     *
     * @param userId 用户ID
     * @return 结果
     */
    int deleteUserById(Long userId);

    /**
     * 批量删除用户信息
     *
     * @param userIds 需要删除的用户ID
     * @return 结果
     */
    int deleteUserByIds(Long[] userIds);

    /**
     * 根据角色ID查询已授权的用户列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectAllocatedList(UserEntity userEntity);

    /**
     * 查询未分配用户的角色列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectUnallocatedList(UserEntity userEntity);

    /**
     * 通过用户ID查询用户
     *
     * @param userId 用户ID
     * @return 用户对象信息
     */
    UserEntity selectUserById(@Param("userId") Long userId);

    /**
     * 校验用户名称是否唯一
     *
     * @param userName 用户名称
     * @return 结果
     */
    UserEntity checkUserNameUnique(@Param("userName") String userName);

    /**
     * 校验手机号码是否唯一
     *
     * @param phoneNumber 手机号码
     * @return 结果
     */
    UserEntity checkPhoneUnique(@Param("phoneNumber") String phoneNumber);

    /**
     * 校验email是否唯一
     *
     * @param email 用户邮箱
     * @return 结果
     */
    UserEntity checkEmailUnique(@Param("email") String email);

}
